negotiator.boaframework
Class BOAparameter

java.lang.Object
  extended by negotiator.boaframework.BOAparameter

public class BOAparameter
extends java.lang.Object

Class used to store the information of a BOA parameter. Basically, what is stored is [Lowerbound:Stepsize:Upperbound]. [1:5:20] = {1, 6, 11, 16}. Please report bugs to author.

Version:
16-01-12
Author:
Mark Hendrikx (m.j.c.hendrikx@student.tudelft.nl)

Constructor Summary
BOAparameter(java.lang.String name, java.math.BigDecimal low, java.math.BigDecimal high, java.math.BigDecimal step)
          Describes a parameter for a BOA component.
BOAparameter(java.lang.String name, java.math.BigDecimal low, java.math.BigDecimal high, java.math.BigDecimal step, java.lang.String description)
          Describes a parameter for a decoupled component.
BOAparameter(java.lang.String name, java.math.BigDecimal defaultValue, java.lang.String description)
          Describes a parameter for a BOA component.
 
Method Summary
 java.lang.String getDescription()
           
 java.math.BigDecimal getHigh()
           
 java.math.BigDecimal getLow()
           
 java.lang.String getName()
           
 java.math.BigDecimal getStep()
           
 java.util.HashSet<Pair<java.lang.String,java.math.BigDecimal>> getValuePairs()
          Returns all values of the parameters which satisfy [Lowerbound:Stepsize:Upperbound].
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BOAparameter

public BOAparameter(java.lang.String name,
                    java.math.BigDecimal low,
                    java.math.BigDecimal high,
                    java.math.BigDecimal step)
Describes a parameter for a BOA component. A parameter consists of a name, and the possible values for the parameter.

Parameters:
name - of the parameter.
low - value of the range.
high - value of the range.
step - of the range.

BOAparameter

public BOAparameter(java.lang.String name,
                    java.math.BigDecimal defaultValue,
                    java.lang.String description)
Describes a parameter for a BOA component. A parameter consists of a name and a description. The value of the parameter is set to a default value.

Parameters:
name -
defaultValue -
description -

BOAparameter

public BOAparameter(java.lang.String name,
                    java.math.BigDecimal low,
                    java.math.BigDecimal high,
                    java.math.BigDecimal step,
                    java.lang.String description)
Describes a parameter for a decoupled component. A parameter consists of a name, a description, and the possible values for the parameter.

Parameters:
name - of the parameter.
low - value of the range.
high - value of the range.
step - of the range.
description - of the parameter.
Method Detail

getValuePairs

public java.util.HashSet<Pair<java.lang.String,java.math.BigDecimal>> getValuePairs()
Returns all values of the parameters which satisfy [Lowerbound:Stepsize:Upperbound].

Returns:
possible values for the parameter specified.

getName

public java.lang.String getName()
Returns:
name of the parameter.

getLow

public java.math.BigDecimal getLow()
Returns:
value for the lowerbound.

getHigh

public java.math.BigDecimal getHigh()
Returns:
upperbound of the range.

getStep

public java.math.BigDecimal getStep()
Returns:
stepsize of the range.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getDescription

public java.lang.String getDescription()
Returns:
description of the parameter.